类 FoxitPDFSDKPython3.ReadingOrder 继承关系图:

Public 成员函数
def	ReadingOrder (pdf_doc)
	构造函数。更多...

def	AddOrderDataForRect (page_index, rect)
	根据选中的矩形区域添加顺序数据。更多...

def	ApplyReadingOrder (page_index, selected_rect)
	根据选中的矩形区域，为指定页面应用阅读顺序。更多...

def	CanMoveDataOrder (page_index, select_info_array, dest_move_item)
	检查数据顺序是否可以移动。更多...

def	CanSelectTableCellAtPoint (page, point)
	检查鼠标在给定点按下时是否可以选择表格单元格。更多...

def	ClearPageStructInfo (page)
	清除页面结构信息。更多...

def	DeleteOrderDataStructInfo (page, src_order_index_array, is_loaded)
	删除顺序数据结构信息。更多...

def	DrawReadingOrderItems (page_index)
	开始绘制指定页面的阅读顺序项。更多...

def	EndEditTable ()
	结束编辑表格。更多...

def	GenerateTableHeaderIDs ()
	自动生成表格表头 ID。更多...

def	GetAllLeafChildrenByContentItemID (content_tree, content_item_id)
	根据内容项 ID 获取所有叶子子项。更多...

def	GetContentTree ()
	获取内容树。更多...

def	GetCurrentTableHeaderIDs ()
	获取当前表格的所有表头 ID。更多...

def	GetReadingOrderTreeItems ()
	获取阅读顺序树项。更多...

def	GetSelectedTableCellAttributes ()
	获取选中的表格单元格属性。更多...

def	GetTableSummary (page)
	获取表格摘要。更多...

def	HasHeaderID (header_id)
	检查当前表格表头 ID 是否已存在。更多...

def	HasMissingHeaderIDs ()
	检查当前表格是否缺少表头 ID。更多...

def	IsEditingTable ()
	检查是否已开始表格编辑。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	MoveOrderData (page_index, src_order_index_array, dest_order_index)
	移动数据顺序。更多...

def	RemoveOrderDataForRect (page_index, rect)
	根据选中的矩形区域移除顺序数据。更多...

def	SelectTableAtPoint (page_index, point)
	选中页面上指定点处的表格（如果存在）。更多...

def	SelectTableCellAtPoint (page, point, region_selected, appended)
	鼠标抬起时通过点选择表格单元格。更多...

def	SelectTableCellAtRect (page, rect, region_selected, appended)
	鼠标抬起时通过矩形区域选择表格单元格。更多...

def	SetOrderTypeForSelectedContent (structure_type)
	根据选中的矩形区域设置顺序类型。更多...

def	SetOrderTypeForSelectedTreeItems (structure_type, select_info_array)
	根据选中的树项设置顺序类型。更多...

def	SetReadingOrderOptions (options)
	设置阅读顺序选项。更多...

def	SetSelectedTableCellAttributes (cell_attribute, change_id_enabled, need_change_ids)
	设置选中的表格单元格属性。更多...

def	SetTableSummary (page, table_summary)
	设置表格摘要。更多...

def	StartEditTable (page)
	开始编辑表格。更多...

def	StartEditTableAtPoint (page, point)
	开始编辑页面上指定点处的表格（如果存在）。更多...

def	SynchronizeTable ()
	同步表格。更多...

静态 Public 属性
	e_StructureTypeBackgroundOrArtifact = _fsdk.ReadingOrder_e_StructureTypeBackgroundOrArtifact
	结构类型：背景或 Artifact。

	e_StructureTypeCaption = _fsdk.ReadingOrder_e_StructureTypeCaption
	结构类型：标题。

	e_StructureTypeCell = _fsdk.ReadingOrder_e_StructureTypeCell
	结构类型：单元格。

	e_StructureTypeFigure = _fsdk.ReadingOrder_e_StructureTypeFigure
	结构类型：图形。

	e_StructureTypeFigureOrCaption = _fsdk.ReadingOrder_e_StructureTypeFigureOrCaption
	结构类型：图形或标题。

	e_StructureTypeFormfield = _fsdk.ReadingOrder_e_StructureTypeFormfield
	结构类型：表单域。

	e_StructureTypeFormula = _fsdk.ReadingOrder_e_StructureTypeFormula
	结构类型：公式。

	e_StructureTypeH1 = _fsdk.ReadingOrder_e_StructureTypeH1
	结构类型：H1。

	e_StructureTypeH2 = _fsdk.ReadingOrder_e_StructureTypeH2
	结构类型：H2。

	e_StructureTypeH3 = _fsdk.ReadingOrder_e_StructureTypeH3
	结构类型：H3。

	e_StructureTypeH4 = _fsdk.ReadingOrder_e_StructureTypeH4
	结构类型：H4。

	e_StructureTypeH5 = _fsdk.ReadingOrder_e_StructureTypeH5
	结构类型：H5。

	e_StructureTypeH6 = _fsdk.ReadingOrder_e_StructureTypeH6
	结构类型：H6。

	e_StructureTypeNote = _fsdk.ReadingOrder_e_StructureTypeNote
	结构类型：注释。

	e_StructureTypeReference = _fsdk.ReadingOrder_e_StructureTypeReference
	结构类型：引用。

	e_StructureTypeTable = _fsdk.ReadingOrder_e_StructureTypeTable
	结构类型：表格。

	e_StructureTypeText = _fsdk.ReadingOrder_e_StructureTypeText
	结构类型：文本。

	e_TableSelectResultNone = _fsdk.ReadingOrder_e_TableSelectResultNone
	表格选择结果：无。

	e_TableSelectResultNoTableExist = _fsdk.ReadingOrder_e_TableSelectResultNoTableExist
	表格选择结果：不存在表格。

	e_TableSelectResultNotInTable = _fsdk.ReadingOrder_e_TableSelectResultNotInTable
	表格选择结果：不在表格中。

	e_TableSelectResultNotSamePage = _fsdk.ReadingOrder_e_TableSelectResultNotSamePage
	表格选择结果：不在同一页。

	e_TableSelectResultNotStarted = _fsdk.ReadingOrder_e_TableSelectResultNotStarted
	表格选择结果：未开始。

详细描述

此类表示用于 PDF 文档辅助功能阅读顺序操作的阅读顺序。使用此模块中的任何类或方法之前，请确保已通过带有 "Accessibility" 模块授权的 key 调用 FoxitPDFSDKPython3.Library.Initialize 函数成功初始化 Foxit PDF SDK。

参见: FoxitPDFSDKPython3.Library

构造及析构函数说明

◆ ReadingOrder()

def FoxitPDFSDKPython3.ReadingOrder.ReadingOrder ( pdf_doc )

构造函数。

构造函数，使用另一个阅读顺序对象。

参数

[in]	pdf_doc	有效的 PDF 文档对象。
[in]	other	另一个阅读顺序对象。

成员函数说明

◆ AddOrderDataForRect()

def FoxitPDFSDKPython3.ReadingOrder.AddOrderDataForRect	(	page_index,
		rect
	)

根据选中的矩形区域添加顺序数据。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	rect	选中的矩形区域。

返回: 矩形数组。

◆ ApplyReadingOrder()

def FoxitPDFSDKPython3.ReadingOrder.ApplyReadingOrder	(	page_index,
		selected_rect
	)

根据选中的矩形区域，为指定页面应用阅读顺序。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	selected_rect	用于应用阅读顺序的选中矩形区域数组。

返回: true 表示成功，false 表示不成功。

◆ CanMoveDataOrder()

def FoxitPDFSDKPython3.ReadingOrder.CanMoveDataOrder	(	page_index,
		select_info_array,
		dest_move_item
	)

检查数据顺序是否可以移动。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	select_info_array	选中信息数组。
[in]	dest_move_item	目标移动项。

返回: true 表示数据顺序可以移动，false 表示不可以移动。

◆ CanSelectTableCellAtPoint()

def FoxitPDFSDKPython3.ReadingOrder.CanSelectTableCellAtPoint	(	page,
		point
	)

检查鼠标在给定点按下时是否可以选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	point	点，采用 PDF 坐标系（PDFPage）。

返回: 表格选择结果。请参见从 FoxitPDFSDKPython3.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ ClearPageStructInfo()

def FoxitPDFSDKPython3.ReadingOrder.ClearPageStructInfo ( page )

清除页面结构信息。

参数

[in] page PDF 页面对象。

返回: 无。

◆ DeleteOrderDataStructInfo()

def FoxitPDFSDKPython3.ReadingOrder.DeleteOrderDataStructInfo	(	page,
		src_order_index_array,
		is_loaded
	)

删除顺序数据结构信息。

参数

[in]	page	PDF 页面对象。
[in]	src_order_index_array	源顺序索引数组。
[in]	is_loaded	页面是否已加载。

返回: 已删除的数量。

◆ DrawReadingOrderItems()

def FoxitPDFSDKPython3.ReadingOrder.DrawReadingOrderItems ( page_index )

开始绘制指定页面的阅读顺序项。

参数

[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。

返回: true 表示成功，false 表示不成功。

◆ EndEditTable()

def FoxitPDFSDKPython3.ReadingOrder.EndEditTable ( )

结束编辑表格。

返回: true 表示成功，false 表示不成功。

◆ GenerateTableHeaderIDs()

def FoxitPDFSDKPython3.ReadingOrder.GenerateTableHeaderIDs ( )

自动生成表格表头 ID。

返回: true 表示成功，false 表示不成功。

◆ GetAllLeafChildrenByContentItemID()

def FoxitPDFSDKPython3.ReadingOrder.GetAllLeafChildrenByContentItemID	(	content_tree,
		content_item_id
	)

根据内容项 ID 获取所有叶子子项。

参数

[in]	content_tree	内容树。
[in]	content_item_id	内容项 ID。

返回: 叶子子项 ID 数组。

◆ GetContentTree()

def FoxitPDFSDKPython3.ReadingOrder.GetContentTree ( )

获取内容树。

返回: 内容树项数组。

◆ GetCurrentTableHeaderIDs()

def FoxitPDFSDKPython3.ReadingOrder.GetCurrentTableHeaderIDs ( )

获取当前表格的所有表头 ID。

返回: 表头 ID 数组。

◆ GetReadingOrderTreeItems()

def FoxitPDFSDKPython3.ReadingOrder.GetReadingOrderTreeItems ( )

获取阅读顺序树项。

返回: 阅读顺序树项数组。

◆ GetSelectedTableCellAttributes()

def FoxitPDFSDKPython3.ReadingOrder.GetSelectedTableCellAttributes ( )

获取选中的表格单元格属性。

返回: 单元格属性对象数组。

◆ GetTableSummary()

def FoxitPDFSDKPython3.ReadingOrder.GetTableSummary ( page )

获取表格摘要。

参数

[in] page PDF 页面对象。

返回: 表格摘要文本。

◆ HasHeaderID()

def FoxitPDFSDKPython3.ReadingOrder.HasHeaderID ( header_id )

检查当前表格表头 ID 是否已存在。

参数

[in] header_id 要检查的表头 ID。

返回: true 表示该表头 ID 已存在，false 表示不存在。

◆ HasMissingHeaderIDs()

def FoxitPDFSDKPython3.ReadingOrder.HasMissingHeaderIDs ( )

检查当前表格是否缺少表头 ID。

返回: true 表示当前表格缺少表头 ID，false 表示未缺少。

◆ IsEditingTable()

def FoxitPDFSDKPython3.ReadingOrder.IsEditingTable ( )

检查是否已开始表格编辑。

返回: true 表示已开始表格编辑，false 表示未开始。

◆ IsEmpty()

def FoxitPDFSDKPython3.ReadingOrder.IsEmpty ( )

检查当前对象是否为空。

返回: true 表示当前对象为空，false 表示非空。

◆ MoveOrderData()

def FoxitPDFSDKPython3.ReadingOrder.MoveOrderData	(	page_index,
		src_order_index_array,
		dest_order_index
	)

移动数据顺序。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	src_order_index_array	源顺序索引数组。
[in]	dest_order_index	目标顺序索引。

返回: 已移动的数量。

◆ RemoveOrderDataForRect()

def FoxitPDFSDKPython3.ReadingOrder.RemoveOrderDataForRect	(	page_index,
		rect
	)

根据选中的矩形区域移除顺序数据。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	rect	选中的矩形区域。

返回: 矩形数组。

◆ SelectTableAtPoint()

def FoxitPDFSDKPython3.ReadingOrder.SelectTableAtPoint	(	page_index,
		point
	)

选中页面上指定点处的表格（如果存在）。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 FoxitPDFSDKPython3.PDFDoc.GetPageCount 返回的页面总数。
[in]	point	用于定位表格的点，使用 PDF 页面坐标系。

返回: true 表示在指定点处找到并选中了表格，false 表示未找到。

◆ SelectTableCellAtPoint()

def FoxitPDFSDKPython3.ReadingOrder.SelectTableCellAtPoint	(	page,
		point,
		region_selected,
		appended
	)

鼠标抬起时通过点选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	point	点。
[out]	region_selected	选中区域数组。
[in]	appended	是否追加选择。

返回: 表格选择结果。请参见从 FoxitPDFSDKPython3.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ SelectTableCellAtRect()

def FoxitPDFSDKPython3.ReadingOrder.SelectTableCellAtRect	(	page,
		rect,
		region_selected,
		appended
	)

鼠标抬起时通过矩形区域选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	rect	矩形区域。
[out]	region_selected	选中区域数组。
[in]	appended	是否追加选择。

返回: 表格选择结果。请参见从 FoxitPDFSDKPython3.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ SetOrderTypeForSelectedContent()

def FoxitPDFSDKPython3.ReadingOrder.SetOrderTypeForSelectedContent ( structure_type )

根据选中的矩形区域设置顺序类型。

参数

[in] structure_type 结构类型。请参见从开始的值，该值应为其中之一。

返回: true 表示成功，false 表示不成功。

◆ SetOrderTypeForSelectedTreeItems()

def FoxitPDFSDKPython3.ReadingOrder.SetOrderTypeForSelectedTreeItems	(	structure_type,
		select_info_array
	)

根据选中的树项设置顺序类型。

参数

[in]	structure_type	结构类型。请参见。
[in]	select_info_array	选中信息数组。

返回: true 表示成功，false 表示不成功。

◆ SetReadingOrderOptions()

def FoxitPDFSDKPython3.ReadingOrder.SetReadingOrderOptions ( options )

设置阅读顺序选项。

参数

[in] options 阅读顺序选项。请参见 ReadingOrderOptions 。

返回: 无。

◆ SetSelectedTableCellAttributes()

def FoxitPDFSDKPython3.ReadingOrder.SetSelectedTableCellAttributes	(	cell_attribute,
		change_id_enabled,
		need_change_ids
	)

设置选中的表格单元格属性。

参数

[in]	cell_attribute	要设置的单元格属性。
[in]	change_id_enabled	是否允许更改 ID。
[in]	need_change_ids	是否更改 ID。

返回: true 表示成功，false 表示不成功。

◆ SetTableSummary()

def FoxitPDFSDKPython3.ReadingOrder.SetTableSummary	(	page,
		table_summary
	)

设置表格摘要。

参数

[in]	page	PDF 页面对象。
[in]	table_summary	表格摘要文本。

返回: true 表示成功，false 表示不成功。

◆ StartEditTable()

def FoxitPDFSDKPython3.ReadingOrder.StartEditTable ( page )

开始编辑表格。

参数

[in] page PDF 页面对象。

返回: true 表示成功，false 表示不成功。

◆ StartEditTableAtPoint()

def FoxitPDFSDKPython3.ReadingOrder.StartEditTableAtPoint	(	page,
		point
	)

开始编辑页面上指定点处的表格（如果存在）。

参数

[in]	page	PDF 页面对象。
[in]	point	用于定位待编辑表格的点，采用 PDF 坐标系（PDFPage）。

返回: true 表示在指定点处找到表格并成功开始编辑，false 表示未找到或开始编辑失败。

◆ SynchronizeTable()

def FoxitPDFSDKPython3.ReadingOrder.SynchronizeTable ( )

同步表格。

返回: 无。

Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ ReadingOrder()

成员函数说明

◆ AddOrderDataForRect()

◆ ApplyReadingOrder()

◆ CanMoveDataOrder()

◆ CanSelectTableCellAtPoint()

◆ ClearPageStructInfo()

◆ DeleteOrderDataStructInfo()

◆ DrawReadingOrderItems()

◆ EndEditTable()

◆ GenerateTableHeaderIDs()

◆ GetAllLeafChildrenByContentItemID()

◆ GetContentTree()

◆ GetCurrentTableHeaderIDs()

◆ GetReadingOrderTreeItems()

◆ GetSelectedTableCellAttributes()

◆ GetTableSummary()

◆ HasHeaderID()

◆ HasMissingHeaderIDs()

◆ IsEditingTable()

◆ IsEmpty()

◆ MoveOrderData()

◆ RemoveOrderDataForRect()

◆ SelectTableAtPoint()

◆ SelectTableCellAtPoint()

◆ SelectTableCellAtRect()

◆ SetOrderTypeForSelectedContent()

◆ SetOrderTypeForSelectedTreeItems()

◆ SetReadingOrderOptions()

◆ SetSelectedTableCellAttributes()

◆ SetTableSummary()

◆ StartEditTable()

◆ StartEditTableAtPoint()

◆ SynchronizeTable()